home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_groff.idb / usr / freeware / info / groff-1.z / groff-1
Text File  |  2002-04-08  |  48KB  |  1,175 lines
  1. This is groff, produced by makeinfo version 4.0 from groff.texinfo.
  2.  
  3. INFO-DIR-SECTION Miscellaneous
  4. START-INFO-DIR-ENTRY
  5. * Groff: (groff).  The GNU troff document formatting system.
  6. END-INFO-DIR-ENTRY
  7.  
  8.    This Info file documents GNU troff version 1.16.
  9.  
  10.    Published by the Free Software Foundation 59 Temple Place, Suite 330
  11. Boston, MA  02111-1307  USA
  12.  
  13.    Copyright (C) 1994-2000 Free Software Foundation, Inc.
  14.  
  15.    Permission is granted to make and distribute verbatim copies of this
  16. manual provided the copyright notice and this permission notice are
  17. preserved on all copies.
  18.  
  19.    Permission is granted to copy and distribute modified versions of
  20. this manual under the conditions for verbatim copying, provided that the
  21. entire resulting derived work is distributed under the terms of a
  22. permission notice identical to this one.
  23.  
  24.    Permission is granted to copy and distribute translations of this
  25. manual into another language, under the above conditions for modified
  26. versions, except that this permission notice may be stated in a
  27. translation approved by the Foundation.
  28.  
  29.    Permission is granted to copy and distribute modified versions of
  30. this manual under the conditions for verbatim copying, provided also
  31. that the section entitled "GNU General Public License" is included
  32. exactly as in the original, and provided that the entire resulting
  33. derived work is distributed under the terms of a permission notice
  34. identical to this one.
  35.  
  36.    Permission is granted to copy and distribute translations of this
  37. manual into another language, under the above conditions for modified
  38. versions, except that the section entitled "GNU General Public License"
  39. may be included in a translation approved by the Free Software
  40. Foundation instead of in the original English.
  41.  
  42. 
  43. File: groff,  Node: Top,  Next: Copying,  Prev: (dir),  Up: (dir)
  44.  
  45.    This Info file documents groff version 1.16, the GNU implementation
  46. of the troff typesetting system.
  47.  
  48.    This is an in-progress document; contributions, comments, or
  49. contributions are welcome.  Send them to bug-groff@gnu.org.
  50.  
  51. * Menu:
  52.  
  53. * Copying::
  54. * Introduction::
  55. * Invoking groff::
  56. * Tutorial for Macro Users::
  57. * Macro Packages::
  58. * gtroff Reference::
  59. * Preprocessors::
  60. * Output Devices::
  61. * File formats::
  62. * Installation::
  63. * Request Index::
  64. * Escape Index::
  65. * Operator Index::
  66. * Register Index::
  67. * Macro Index::
  68. * String Index::
  69. * Glyph Name Index::
  70. * Font File Keyword Index::
  71. * Program and File Index::
  72. * Concept Index::
  73.  
  74. 
  75. File: groff,  Node: Copying,  Next: Introduction,  Prev: Top,  Up: Top
  76.  
  77. GNU GENERAL PUBLIC LICENSE
  78. **************************
  79.  
  80.                          Version 2, June 1991
  81.  
  82.      Copyright (C) 1989, 1991 Free Software Foundation, Inc.
  83.      59 Temple Place, Suite 330, Boston, MA 02111, USA
  84.      
  85.      Everyone is permitted to copy and distribute verbatim copies of this
  86.      license document, but changing it is not allowed.
  87.  
  88. Preamble
  89. ========
  90.  
  91.    The licenses for most software are designed to take away your
  92. freedom to share and change it.  By contrast, the GNU General Public
  93. License is intended to guarantee your freedom to share and change free
  94. software - to make sure the software is free for all its users.  This
  95. General Public License applies to most of the Free Software Foundation's
  96. software and to any other program whose authors commit to using it.
  97. (Some other Free Software Foundation software is covered by the GNU
  98. Library General Public License instead.)  You can apply it to your
  99. programs, too.
  100.  
  101.    When we speak of free software, we are referring to freedom, not
  102. price.  Our General Public Licenses are designed to make sure that you
  103. have the freedom to distribute copies of free software (and charge for
  104. this service if you wish), that you receive source code or can get it
  105. if you want it, that you can change the software or use pieces of it in
  106. new free programs; and that you know you can do these things.
  107.  
  108.    To protect your rights, we need to make restrictions that forbid
  109. anyone to deny you these rights or to ask you to surrender the rights.
  110. These restrictions translate to certain responsibilities for you if you
  111. distribute copies of the software, or if you modify it.
  112.  
  113.    For example, if you distribute copies of such a program, whether
  114. gratis or for a fee, you must give the recipients all the rights that
  115. you have.  You must make sure that they, too, receive or can get the
  116. source code.  And you must show them these terms so they know their
  117. rights.
  118.  
  119.    We protect your rights with two steps: (1) copyright the software,
  120. and (2) offer you this license which gives you legal permission to
  121. copy, distribute and/or modify the software.
  122.  
  123.    Also, for each author's protection and ours, we want to make certain
  124. that everyone understands that there is no warranty for this free
  125. software.  If the software is modified by someone else and passed on, we
  126. want its recipients to know that what they have is not the original, so
  127. that any problems introduced by others will not reflect on the original
  128. authors' reputations.
  129.  
  130.    Finally, any free program is threatened constantly by software
  131. patents.  We wish to avoid the danger that redistributors of a free
  132. program will individually obtain patent licenses, in effect making the
  133. program proprietary.  To prevent this, we have made it clear that any
  134. patent must be licensed for everyone's free use or not licensed at all.
  135.  
  136.    The precise terms and conditions for copying, distribution and
  137. modification follow.
  138.  
  139.     TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
  140.  
  141.   0. This License applies to any program or other work which contains a
  142.      notice placed by the copyright holder saying it may be distributed
  143.      under the terms of this General Public License.  The "Program",
  144.      below, refers to any such program or work, and a "work based on
  145.      the Program" means either the Program or any derivative work under
  146.      copyright law: that is to say, a work containing the Program or a
  147.      portion of it, either verbatim or with modifications and/or
  148.      translated into another language.  (Hereinafter, translation is
  149.      included without limitation in the term "modification".)  Each
  150.      licensee is addressed as "you".
  151.  
  152.      Activities other than copying, distribution and modification are
  153.      not covered by this License; they are outside its scope.  The act
  154.      of running the Program is not restricted, and the output from the
  155.      Program is covered only if its contents constitute a work based on
  156.      the Program (independent of having been made by running the
  157.      Program).  Whether that is true depends on what the Program does.
  158.  
  159.   1. You may copy and distribute verbatim copies of the Program's
  160.      source code as you receive it, in any medium, provided that you
  161.      conspicuously and appropriately publish on each copy an
  162.      appropriate copyright notice and disclaimer of warranty; keep
  163.      intact all the notices that refer to this License and to the
  164.      absence of any warranty; and give any other recipients of the
  165.      Program a copy of this License along with the Program.
  166.  
  167.      You may charge a fee for the physical act of transferring a copy,
  168.      and you may at your option offer warranty protection in exchange
  169.      for a fee.
  170.  
  171.   2. You may modify your copy or copies of the Program or any portion
  172.      of it, thus forming a work based on the Program, and copy and
  173.      distribute such modifications or work under the terms of Section 1
  174.      above, provided that you also meet all of these conditions:
  175.  
  176.        a. You must cause the modified files to carry prominent notices
  177.           stating that you changed the files and the date of any change.
  178.  
  179.        b. You must cause any work that you distribute or publish, that
  180.           in whole or in part contains or is derived from the Program
  181.           or any part thereof, to be licensed as a whole at no charge
  182.           to all third parties under the terms of this License.
  183.  
  184.        c. If the modified program normally reads commands interactively
  185.           when run, you must cause it, when started running for such
  186.           interactive use in the most ordinary way, to print or display
  187.           an announcement including an appropriate copyright notice and
  188.           a notice that there is no warranty (or else, saying that you
  189.           provide a warranty) and that users may redistribute the
  190.           program under these conditions, and telling the user how to
  191.           view a copy of this License.  (Exception: if the Program
  192.           itself is interactive but does not normally print such an
  193.           announcement, your work based on the Program is not required
  194.           to print an announcement.)
  195.  
  196.      These requirements apply to the modified work as a whole.  If
  197.      identifiable sections of that work are not derived from the
  198.      Program, and can be reasonably considered independent and separate
  199.      works in themselves, then this License, and its terms, do not
  200.      apply to those sections when you distribute them as separate
  201.      works.  But when you distribute the same sections as part of a
  202.      whole which is a work based on the Program, the distribution of
  203.      the whole must be on the terms of this License, whose permissions
  204.      for other licensees extend to the entire whole, and thus to each
  205.      and every part regardless of who wrote it.
  206.  
  207.      Thus, it is not the intent of this section to claim rights or
  208.      contest your rights to work written entirely by you; rather, the
  209.      intent is to exercise the right to control the distribution of
  210.      derivative or collective works based on the Program.
  211.  
  212.      In addition, mere aggregation of another work not based on the
  213.      Program with the Program (or with a work based on the Program) on
  214.      a volume of a storage or distribution medium does not bring the
  215.      other work under the scope of this License.
  216.  
  217.   3. You may copy and distribute the Program (or a work based on it,
  218.      under Section 2) in object code or executable form under the terms
  219.      of Sections 1 and 2 above provided that you also do one of the
  220.      following:
  221.  
  222.        a. Accompany it with the complete corresponding machine-readable
  223.           source code, which must be distributed under the terms of
  224.           Sections 1 and 2 above on a medium customarily used for
  225.           software interchange; or,
  226.  
  227.        b. Accompany it with a written offer, valid for at least three
  228.           years, to give any third party, for a charge no more than
  229.           your cost of physically performing source distribution, a
  230.           complete machine-readable copy of the corresponding source
  231.           code, to be distributed under the terms of Sections 1 and 2
  232.           above on a medium customarily used for software interchange;
  233.           or,
  234.  
  235.        c. Accompany it with the information you received as to the
  236.           offer to distribute corresponding source code.  (This
  237.           alternative is allowed only for noncommercial distribution
  238.           and only if you received the program in object code or
  239.           executable form with such an offer, in accord with
  240.           Subsection b above.)
  241.  
  242.      The source code for a work means the preferred form of the work for
  243.      making modifications to it.  For an executable work, complete
  244.      source code means all the source code for all modules it contains,
  245.      plus any associated interface definition files, plus the scripts
  246.      used to control compilation and installation of the executable.
  247.      However, as a special exception, the source code distributed need
  248.      not include anything that is normally distributed (in either
  249.      source or binary form) with the major components (compiler,
  250.      kernel, and so on) of the operating system on which the executable
  251.      runs, unless that component itself accompanies the executable.
  252.  
  253.      If distribution of executable or object code is made by offering
  254.      access to copy from a designated place, then offering equivalent
  255.      access to copy the source code from the same place counts as
  256.      distribution of the source code, even though third parties are not
  257.      compelled to copy the source along with the object code.
  258.  
  259.   4. You may not copy, modify, sublicense, or distribute the Program
  260.      except as expressly provided under this License.  Any attempt
  261.      otherwise to copy, modify, sublicense or distribute the Program is
  262.      void, and will automatically terminate your rights under this
  263.      License.  However, parties who have received copies, or rights,
  264.      from you under this License will not have their licenses
  265.      terminated so long as such parties remain in full compliance.
  266.  
  267.   5. You are not required to accept this License, since you have not
  268.      signed it.  However, nothing else grants you permission to modify
  269.      or distribute the Program or its derivative works.  These actions
  270.      are prohibited by law if you do not accept this License.
  271.      Therefore, by modifying or distributing the Program (or any work
  272.      based on the Program), you indicate your acceptance of this
  273.      License to do so, and all its terms and conditions for copying,
  274.      distributing or modifying the Program or works based on it.
  275.  
  276.   6. Each time you redistribute the Program (or any work based on the
  277.      Program), the recipient automatically receives a license from the
  278.      original licensor to copy, distribute or modify the Program
  279.      subject to these terms and conditions.  You may not impose any
  280.      further restrictions on the recipients' exercise of the rights
  281.      granted herein.  You are not responsible for enforcing compliance
  282.      by third parties to this License.
  283.  
  284.   7. If, as a consequence of a court judgment or allegation of patent
  285.      infringement or for any other reason (not limited to patent
  286.      issues), conditions are imposed on you (whether by court order,
  287.      agreement or otherwise) that contradict the conditions of this
  288.      License, they do not excuse you from the conditions of this
  289.      License.  If you cannot distribute so as to satisfy simultaneously
  290.      your obligations under this License and any other pertinent
  291.      obligations, then as a consequence you may not distribute the
  292.      Program at all.  For example, if a patent license would not permit
  293.      royalty-free redistribution of the Program by all those who
  294.      receive copies directly or indirectly through you, then the only
  295.      way you could satisfy both it and this License would be to refrain
  296.      entirely from distribution of the Program.
  297.  
  298.      If any portion of this section is held invalid or unenforceable
  299.      under any particular circumstance, the balance of the section is
  300.      intended to apply and the section as a whole is intended to apply
  301.      in other circumstances.
  302.  
  303.      It is not the purpose of this section to induce you to infringe any
  304.      patents or other property right claims or to contest validity of
  305.      any such claims; this section has the sole purpose of protecting
  306.      the integrity of the free software distribution system, which is
  307.      implemented by public license practices.  Many people have made
  308.      generous contributions to the wide range of software distributed
  309.      through that system in reliance on consistent application of that
  310.      system; it is up to the author/donor to decide if he or she is
  311.      willing to distribute software through any other system and a
  312.      licensee cannot impose that choice.
  313.  
  314.      This section is intended to make thoroughly clear what is believed
  315.      to be a consequence of the rest of this License.
  316.  
  317.   8. If the distribution and/or use of the Program is restricted in
  318.      certain countries either by patents or by copyrighted interfaces,
  319.      the original copyright holder who places the Program under this
  320.      License may add an explicit geographical distribution limitation
  321.      excluding those countries, so that distribution is permitted only
  322.      in or among countries not thus excluded.  In such case, this
  323.      License incorporates the limitation as if written in the body of
  324.      this License.
  325.  
  326.   9. The Free Software Foundation may publish revised and/or new
  327.      versions of the General Public License from time to time.  Such
  328.      new versions will be similar in spirit to the present version, but
  329.      may differ in detail to address new problems or concerns.
  330.  
  331.      Each version is given a distinguishing version number.  If the
  332.      Program specifies a version number of this License which applies
  333.      to it and "any later version", you have the option of following
  334.      the terms and conditions either of that version or of any later
  335.      version published by the Free Software Foundation.  If the Program
  336.      does not specify a version number of this License, you may choose
  337.      any version ever published by the Free Software Foundation.
  338.  
  339.  10. If you wish to incorporate parts of the Program into other free
  340.      programs whose distribution conditions are different, write to the
  341.      author to ask for permission.  For software which is copyrighted
  342.      by the Free Software Foundation, write to the Free Software
  343.      Foundation; we sometimes make exceptions for this.  Our decision
  344.      will be guided by the two goals of preserving the free status of
  345.      all derivatives of our free software and of promoting the sharing
  346.      and reuse of software generally.
  347.  
  348.                                 NO WARRANTY
  349.  
  350.  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
  351.      WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
  352.      LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
  353.      HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
  354.      WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT
  355.      NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  356.      FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO THE
  357.      QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
  358.      PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
  359.      SERVICING, REPAIR OR CORRECTION.
  360.  
  361.  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
  362.      WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
  363.      MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
  364.      LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  365.      INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
  366.      INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
  367.      DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU
  368.      OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
  369.      OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
  370.      ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  371.  
  372.                       END OF TERMS AND CONDITIONS
  373.  
  374. How to Apply These Terms to Your New Programs
  375. =============================================
  376.  
  377.    If you develop a new program, and you want it to be of the greatest
  378. possible use to the public, the best way to achieve this is to make it
  379. free software which everyone can redistribute and change under these
  380. terms.
  381.  
  382.    To do so, attach the following notices to the program.  It is safest
  383. to attach them to the start of each source file to most effectively
  384. convey the exclusion of warranty; and each file should have at least the
  385. "copyright" line and a pointer to where the full notice is found.
  386.  
  387.      ONE LINE TO GIVE THE PROGRAM'S NAME AND AN IDEA OF WHAT IT DOES.
  388.      Copyright (C) 19YY NAME OF AUTHOR
  389.      
  390.      This program is free software; you can redistribute it and/or modify
  391.      it under the terms of the GNU General Public License as published by
  392.      the Free Software Foundation; either version 2 of the License, or (at
  393.      your option) any later version.
  394.      
  395.      This program is distributed in the hope that it will be useful, but
  396.      WITHOUT ANY WARRANTY; without even the implied warranty of
  397.      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  398.      General Public License for more details.
  399.      
  400.      You should have received a copy of the GNU General Public License
  401.      along with this program; if not, write to the Free Software
  402.      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  403.  
  404.    Also add information on how to contact you by electronic and paper
  405. mail.
  406.  
  407.    If the program is interactive, make it output a short notice like
  408. this when it starts in an interactive mode:
  409.  
  410.      Gnomovision version 69, Copyright (C) 19YY NAME OF AUTHOR
  411.      Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type
  412.      `show w'.  This is free software, and you are welcome to redistribute
  413.      it under certain conditions; type `show c' for details.
  414.  
  415.    The hypothetical commands `show w' and `show c' should show the
  416. appropriate parts of the General Public License.  Of course, the
  417. commands you use may be called something other than `show w' and
  418. `show c'; they could even be mouse-clicks or menu items - whatever
  419. suits your program.
  420.  
  421.    You should also get your employer (if you work as a programmer) or
  422. your school, if any, to sign a "copyright disclaimer" for the program,
  423. if necessary.  Here is a sample; alter the names:
  424.  
  425.      Yoyodyne, Inc., hereby disclaims all copyright interest
  426.      in the program `Gnomovision' (which makes passes at compilers)
  427.      written by James Hacker.
  428.      
  429.      SIGNATURE OF TY COON, 1 April 1989
  430.      Ty Coon, President of Vice
  431.  
  432.    This General Public License does not permit incorporating your
  433. program into proprietary programs.  If your program is a subroutine
  434. library, you may consider it more useful to permit linking proprietary
  435. applications with the library.  If this is what you want to do, use the
  436. GNU Library General Public License instead of this License.
  437.  
  438. 
  439. File: groff,  Node: Introduction,  Next: Invoking groff,  Prev: Copying,  Up: Top
  440.  
  441. Introduction
  442. ************
  443.  
  444.    GNU `troff' (or `groff') is a system for typesetting documents.
  445. `troff' is very flexible and has been in existence (and use) for about
  446. 3 decades.  It is quite widespread and firmly entrenched in the UNIX
  447. community.
  448.  
  449. * Menu:
  450.  
  451. * What Is groff?::
  452. * History::
  453. * groff Capabilities::
  454. * Macro Package Intro::
  455. * Preprocessor Intro::
  456. * Output device intro::
  457. * Credits::
  458.  
  459. 
  460. File: groff,  Node: What Is groff?,  Next: History,  Prev: Introduction,  Up: Introduction
  461.  
  462. What Is `groff'?
  463. ================
  464.  
  465.    `groff' belongs to an older generation of document preparation
  466. systems, which operate more like compilers than the more recent
  467. interactive WYSIWYG(1) (*note What Is groff?-Footnote-1::) systems.
  468. `groff' and its contemporary counterpart, TeX, both work using a
  469. "batch" paradigm: The input (or "source") files are normal text files
  470. with embedded formatting commands.  These files can then be processed
  471. by `groff' to produce a typeset document on a variety of devices.
  472.  
  473.    Likewise, `groff' should not be confused with a "word processor",
  474. since that term connotes an integrated system that includes an editor
  475. and a text formatter.  Also, many word processors follow the WYSIWYG
  476. paradigm discussed earlier.
  477.  
  478.    Although WYSIWYG systems may be easier to use, they have a number of
  479. disadvantages compared to `troff':
  480.  
  481.    * They must be used on a graphics display to work on a document.
  482.  
  483.    * Most of the WYSIWYG systems are either non-free or are not very
  484.      portable.
  485.  
  486.    * `troff' is firmly entrenched in all UNIX systems.
  487.  
  488.    * It is difficult to have a wide range of capabilities available
  489.      within the confines of a GUI/window system.
  490.  
  491.    * It is more difficult to make global changes to a document.
  492.  
  493.      "GUIs normally make it simple to accomplish simple actions and
  494.      impossible to accomplish complex actions."  -Doug Gwyn (22/Jun/91
  495.      in `comp.unix.wizards')
  496.  
  497. 
  498. File: groff,  Node: What Is groff?-Footnotes,  Up: What Is groff?
  499.  
  500.    (1) What You See Is What You Get
  501.  
  502. 
  503. File: groff,  Node: History,  Next: groff Capabilities,  Prev: What Is groff?,  Up: Introduction
  504.  
  505. History
  506. =======
  507.  
  508.    `troff' can trace its origins back to a formatting program called
  509. `runoff', written by J. E. Saltzer, which ran on MIT's CTSS operating
  510. system in the mid-sixties.  This name came from the common phrase of
  511. the time "I'll run off a document."  Bob Morris ported it to the 635
  512. architecture and called the program `roff' (an abbreviation of
  513. `runoff').  It was rewritten as `rf' for the PDP-7 (before having
  514. UNIX), and at the same time (1969), Doug McIllroy rewrote an extended
  515. and simplified version of `roff' in the BCPL programming language.
  516.  
  517.    The first version of UNIX was developed on a PDP-7 which was sitting
  518. around Bell Labs.  In 1971 the developers wanted to get a PDP-11 for
  519. further work on the operating system.  In order to justify the cost for
  520. this system, they proposed that they would implement a document
  521. formatting system for the AT&T patents division.  This first formatting
  522. program was a reimplementation of McIllroy's `roff', written by
  523. J. F. Ossanna.
  524.  
  525.    When they needed a more flexible language, a new version of `roff'
  526. called `nroff' ("Newer `roff'") was written.  It had a much more
  527. complicated syntax, but provided the basis for all future versions.
  528. When they got a Graphic Systems CAT Phototypesetter, Ossanna wrote a
  529. version of `nroff' that would drive it.  It was dubbed `troff', for
  530. "typesetter `roff'", although many people have speculated that it
  531. actually means "Times `roff'" because of the use of the Times font
  532. family in `troff' by default.  As such, the name `troff' is pronounced
  533. `t-roff' rather than `trough'.
  534.  
  535.    With `troff' came `nroff' (they were actually the same program
  536. except for some `#ifdef's), which was for producing output for line
  537. printers and character terminals.  It understood everything `troff'
  538. did, and ignored the commands which were not applicable (e.g. font
  539. changes).
  540.  
  541.    Since there are several things which cannot be done easily in
  542. `troff', work on several preprocessors began.  These programs would
  543. transform certain parts of a document into `troff', which made a very
  544. natural use of pipes in UNIX.
  545.  
  546.    The `eqn' preprocessor allowed mathematical formulae to be specified
  547. in a much simpler and more intuitive manner.  `tbl' is a preprocessor
  548. for formatting tables.  The `refer' preprocessor (and the similar
  549. program, `bib') processes citations in a document according to a
  550. bibliographic database.
  551.  
  552.    Unfortunately, Ossanna's `troff' was written in PDP-11 assembly
  553. language and produced output specifically for the CAT phototypesetter.
  554. He rewrote it in C, although it was now 7000 lines of uncommented code
  555. and still dependent on the CAT.  As the CAT became less common, and was
  556. no longer supported by the manufacturer, the need to make it support
  557. other devices became a priority.  However, before this could be done,
  558. Ossanna was killed in an auto accident.
  559.  
  560.    So, Brian Kernighan took on the task of rewriting `troff'.  The
  561. newly rewritten version produced a device independent code which was
  562. very easy for postprocessors to read and translate to the appropriate
  563. printer codes.  Also, this new version of `troff' (called `ditroff' for
  564. "device independent `troff'") had several extensions, which included
  565. drawing functions.
  566.  
  567.    Due to the additional abilities of the new version of `troff',
  568. several new preprocessors appeared.  The `pic' preprocessor provides a
  569. wide range of drawing functions.  Likewise the `ideal' preprocessor did
  570. the same, although via a much different paradigm.  The `grap'
  571. preprocessor took specifications for graphs, but, unlike other
  572. preprocessors, produced `pic' code.
  573.  
  574.    James Clark began work on a GNU implementation of `ditroff' in
  575. early 1989.  The first version, `groff' 0.3.1, was released June 1990.
  576. `groff' included:
  577.  
  578.    * A replacement for `ditroff' with many extensions.
  579.  
  580.    * The `soelim', `pic', `tbl', and `eqn' preprocessors.
  581.  
  582.    * Postprocessors for character devices, POSTSCRIPT, TeX DVI, and
  583.      X windows.  GNU `troff' also eliminated the need for a separate
  584.      `nroff' program with a postprocessor which would produce ASCII
  585.      output.
  586.  
  587.    * A version of the `me' macros and an implementation of the `man'
  588.      macros.
  589.  
  590.    Also, a front-end was included which could construct the, sometimes
  591. painfully long, pipelines required for all the post- and preprocessors.
  592.  
  593.    Development of GNU `troff' progressed rapidly, and saw the additions
  594. of a replacement for `refer', an implementation of the `ms' and `mm'
  595. macros, and a program to deduce how to format a document (`grog').
  596.  
  597.    It was declared a stable (i.e. non-beta) package with the release of
  598. version 1.04 around November 1991.
  599.  
  600.    Beginning in 1999, `groff' has new maintainers (the package was an
  601. orphan for a few years).  As a result, new features and programs like
  602. `grn', a preprocessor for gremlin images, and an output device to
  603. produce HTML output have been added.
  604.  
  605. 
  606. File: groff,  Node: groff Capabilities,  Next: Macro Package Intro,  Prev: History,  Up: Introduction
  607.  
  608. `groff' Capabilities
  609. ====================
  610.  
  611.    So what exactly is `groff' capable of doing?  `groff' provides a
  612. wide range of low-level text formatting operations.  Using these, it is
  613. possible to perform a wide range of formatting tasks, such as
  614. footnotes, table of contents, multiple columns, etc.  Here's a list of
  615. the most important operations supported by `groff':
  616.  
  617.    * text filling, adjusting, and centering
  618.  
  619.    * hyphenation
  620.  
  621.    * page control
  622.  
  623.    * font and character size control
  624.  
  625.    * vertical spacing (i.e. double spacing)
  626.  
  627.    * line length and indenting
  628.  
  629.    * macros, strings, diversions, and traps
  630.  
  631.    * number registers
  632.  
  633.    * tabs, leaders, and fields
  634.  
  635.    * input and output conventions and character translation
  636.  
  637.    * overstrike, bracket, line drawing, and zero-width functions
  638.  
  639.    * local horizontal and vertical motions and the width function
  640.  
  641.    * three-part titles
  642.  
  643.    * output line numbering
  644.  
  645.    * conditional acceptance of input
  646.  
  647.    * environment switching
  648.  
  649.    * insertions from the standard input
  650.  
  651.    * input/output file switching
  652.  
  653.    * output and error messages
  654.  
  655. 
  656. File: groff,  Node: Macro Package Intro,  Next: Preprocessor Intro,  Prev: groff Capabilities,  Up: Introduction
  657.  
  658. Macro Packages
  659. ==============
  660.  
  661.    Since `groff' provides such low-level facilities, it can be quite
  662. difficult to use by itself.  However, `groff' provides a "macro"
  663. facility to specify how certain routine operations (e.g. starting
  664. paragraphs, printing headers and footers, etc.) should be done.  These
  665. macros can be collected together into a "macro package".  There are a
  666. number of macro packages available; the most common (and the ones
  667. described in this manual) are `man', `mdoc', `me', `ms', and `mm'.
  668.  
  669. 
  670. File: groff,  Node: Preprocessor Intro,  Next: Output device intro,  Prev: Macro Package Intro,  Up: Introduction
  671.  
  672. Preprocessors
  673. =============
  674.  
  675.    Although `groff' provides most functions needed to format a
  676. document, some operations would be unwieldy (e.g. to draw pictures).
  677. Therefore, programs called preprocessors were written which understand
  678. their own language and produce the necessary `groff' operations.  These
  679. preprocessors are able to differentiate their own input from the rest
  680. of the document via markers.
  681.  
  682.    To use a preprocessor, UNIX pipes are used to feed the output from
  683. the preprocessor into `groff'.  Any number of preprocessors may be used
  684. on a given document; in this case, the preprocessors are linked
  685. together into one pipeline.  However, in `groff', the user does not
  686. need to construct the pipe, but only tell `groff' what preprocessors to
  687. use.
  688.  
  689.    `groff' currently has preprocessors for producing tables (`tbl'),
  690. typesetting equations (`eqn'), drawing pictures (`pic' and `grn'), and
  691. for processing bibliographies (`refer').  An associated program which
  692. is useful when dealing with preprocessors is `soelim'.
  693.  
  694.    A free implementation of `grap', a preprocessor for drawing graphs,
  695. can be obtained as an extra package; `groff' can use `grap' also.
  696.  
  697.    There are other preprocessors in existence, but, unfortunately, no
  698. free implementations are available.  Among them are preprocessors for
  699. drawing mathematical pictures (`ideal') and chemical structures
  700. (`chem').
  701.  
  702. 
  703. File: groff,  Node: Output device intro,  Next: Credits,  Prev: Preprocessor Intro,  Up: Introduction
  704.  
  705. Output Devices
  706. ==============
  707.  
  708.    `groff' actually produces device independent code which may be fed
  709. into a postprocessor to produce output for a particular device.
  710. Currently, `groff' has postprocessors for POSTSCRIPT devices, character
  711. terminals, X Windows (for previewing), TeX DVI format, HP LaserJet 4
  712. and Canon LBP printers (which use CAPSL), and HTML.
  713.  
  714. 
  715. File: groff,  Node: Credits,  Prev: Output device intro,  Up: Introduction
  716.  
  717. Credits
  718. =======
  719.  
  720.    Large portions of this manual were taken from existing documents,
  721. most notably, the manual pages for the `groff' package by James Clark,
  722. and Eric Allman's papers on the `me' macro package.
  723.  
  724.    The section on the `man' macro package is partly based on Susan G.
  725. Kleinmann's `groff_man' manual page written for the Debian GNU/Linux
  726. system.
  727.  
  728. 
  729. File: groff,  Node: Invoking groff,  Next: Tutorial for Macro Users,  Prev: Introduction,  Up: Top
  730.  
  731. Invoking `groff'
  732. ****************
  733.  
  734.    This section focuses on how to invoke the `groff' front end.  This
  735. front end takes care of the details of constructing the pipeline among
  736. the preprocessors, `gtroff' and the postprocessor.
  737.  
  738.    It has become a tradition that GNU programs get the prefix `g' to
  739. distinguish it from its original counterparts provided by the host (see
  740. *Note Environment::, for more details).  Thus, for example, `geqn' is
  741. GNU `eqn'.  On operating systems like Linux or the Hurd, which don't
  742. contain proprietary software, and on MS-DOS/MS-Windows, where `troff'
  743. and associated programs are not available at all, this prefix is
  744. omitted since GNU `troff' is the only used incarnation of `troff'.
  745. Exception: `groff' is never replaced by `roff'.
  746.  
  747. * Menu:
  748.  
  749. * Groff Options::
  750. * Environment::
  751. * Invocation Examples::
  752.  
  753. 
  754. File: groff,  Node: Groff Options,  Next: Environment,  Prev: Invoking groff,  Up: Invoking groff
  755.  
  756. Options
  757. =======
  758.  
  759.    `groff' normally runs the `gtroff' program and a postprocessor
  760. appropriate for the selected device.  The default device is `ps' (but
  761. it can be changed when `groff' is configured and built).  It can
  762. optionally preprocess with any of `gpic', `geqn', `gtbl', `ggrn',
  763. `grap', `grefer', or `gsoelim'.
  764.  
  765.    This section only documents options to the `groff' front end.  Many
  766. of the arguments to `groff' are passed on to `gtroff', therefore those
  767. are also included.  Arguments to pre- or postprocessors can be found in
  768. *Note Invoking gpic::, *Note Invoking geqn::, *Note Invoking gtbl::,
  769. *Note Invoking ggrn::, *Note Invoking grefer::, *Note Invoking
  770. gsoelim::, *Note Invoking grotty::, *Note Invoking grops::, *Note
  771. Invoking grohtml::, *Note Invoking grodvi::, *Note Invoking grolj4::,
  772. *Note Invoking grolbp::, and *Note Invoking gxditview::.
  773.  
  774.    The command line format for `groff' is:
  775.  
  776.  
  777.      groff [ -abeghilpstvzCEGNRSUVXZ ] [ -FDIR ] [ -mNAME ]
  778.            [ -TDEF ] [ -fFAM ] [ -wNAME ] [ -WNAME ]
  779.            [ -MDIR ] [ -dCS ] [ -rCN ] [ -nNUM ]
  780.            [ -oLIST ] [ -PARG ] [ -LARG ] [ -IDIR ]
  781.            [ FILES... ]
  782.  
  783.    The command line format for `gtroff' is as follows.
  784.  
  785.  
  786.      gtroff [ -abivzCERU ] [ -wNAME ] [ -WNAME ] [ -dCS ]
  787.             [ -fFAM ] [ -mNAME ] [ -nNUM ]
  788.             [ -oLIST ] [ -rCN ] [ -TNAME ]
  789.             [ -FDIR ] [ -MDIR ] [ FILES... ]
  790.  
  791. Obviously, many of the options to `groff' are actually passed on to
  792. `gtroff'.
  793.  
  794.    Options without an argument can be grouped behind a single `-'.  A
  795. filename of `-' denotes the standard input.  It is possible to have
  796. whitespace between an option and its parameter.
  797.  
  798.    The `grog' command can be used to guess the correct `groff' command
  799. to format a file.
  800.  
  801.    Here's the description of the command-line options:
  802.  
  803. `-h'
  804.      Print a help message.
  805.  
  806. `-e'
  807.      Preprocess with `geqn'.
  808.  
  809. `-t'
  810.      Preprocess with `gtbl'.
  811.  
  812. `-g'
  813.      Preprocess with `ggrn'.
  814.  
  815. `-G'
  816.      Preprocess with `grap'.
  817.  
  818. `-p'
  819.      Preprocess with `gpic'.
  820.  
  821. `-s'
  822.      Preprocess with `gsoelim'.
  823.  
  824. `-R'
  825.      Preprocess with `grefer'.  No mechanism is provided for passing
  826.      arguments to `grefer' because most `grefer' options have
  827.      equivalent commands which can be included in the file.  *Note
  828.      grefer::, for more details.
  829.  
  830.      Note that `gtroff' also accepts a `-R' option, which is not
  831.      accessible via `groff'.  This option prevents the loading of the
  832.      `troffrc' and `troffrc-end' files.
  833.  
  834. `-v'
  835.      Make programs run by `groff' print out their version number.
  836.  
  837. `-V'
  838.      Print the pipeline on `stdout' instead of executing it.
  839.  
  840. `-z'
  841.      Suppress output from `gtroff'.  Only error messages are printed.
  842.  
  843. `-Z'
  844.      Do not postprocess the output of `gtroff'.  Normally `groff'
  845.      automatically runs the appropriate postprocessor.
  846.  
  847. `-PARG'
  848.      Pass ARG to the postprocessor.  Each argument should be passed
  849.      with a separate `-P' option.  Note that `groff' does not prepend
  850.      `-' to ARG before passing it to the postprocessor.
  851.  
  852. `-l'
  853.      Send the output to a spooler for printing.  The command used for
  854.      this is specified by the `print' command in the device description
  855.      file (see *Note Font Files::, for more info).  If not present,
  856.      `-l' is ignored.
  857.  
  858. `-LARG'
  859.      Pass ARG to the spooler.  Each argument should be passed with a
  860.      separate `-L' option.  Note that `groff' does not prepend a `-' to
  861.      ARG before passing it to the postprocessor.  If the `print'
  862.      keyword in the device description file is missing, `-L' is ignored.
  863.  
  864. `-TDEV'
  865.      Prepare output for device DEV.  The default device is `ps', unless
  866.      changed when `groff' was configured and built.  The following are
  867.      the output devices currently available:
  868.  
  869.     `ps'
  870.           For POSTSCRIPT printers and previewers.
  871.  
  872.     `dvi'
  873.           For TeX DVI format.
  874.  
  875.     `X75'
  876.           For a 75dpi X11 previewer.
  877.  
  878.     `X100'
  879.           For a 100dpi X11 previewer.
  880.  
  881.     `ascii'
  882.           For typewriter-like devices.
  883.  
  884.     `latin1'
  885.           For typewriter-like devices that support the Latin-1
  886.           (ISO 8859-1) character set.
  887.  
  888.     `utf8'
  889.           For typewriter-like devices which use the Unicode (ISO 10646)
  890.           character set with UTF-8 encoding.
  891.  
  892.     `cp1047'
  893.           For typewriter-like devices which use the EBCDIC encoding IBM
  894.           cp1047.
  895.  
  896.     `lj4'
  897.           For an HP LaserJet4-compatible (or other PCL5-compatible)
  898.           printer.
  899.  
  900.     `lbp'
  901.           For Canon CAPSL printers (LBP-4 and LBP-8 series laser
  902.           printers).
  903.  
  904.     `html'
  905.           To produce HTML output.  Note that the HTML driver consists
  906.           of two parts, a preprocessor (`pre-grohtml') and a
  907.           postprocessor (`post-grohtml').
  908.  
  909.      The predefined `gtroff' string register `.T' contains the current
  910.      output device; the read-only number register `.T' is set to 1 if
  911.      this option is used (which is always true if `groff' is used to
  912.      call `gtroff').  *Note Built-in Registers::.
  913.  
  914.      The postprocessor to be used for a device is specified by the
  915.      `postpro' command in the device description file.  (*Note Font
  916.      Files::, for more info.)  This can be overridden with the `-X'
  917.      option.
  918.  
  919. `-X'
  920.      Preview with `gxditview' instead of using the usual postprocessor.
  921.      This is unlikely to produce good results except with `-Tps'.
  922.  
  923.      Note that this is not the same as using `-TX75' or `-TX100' to
  924.      view a document with `gxditview': The former uses the metrics of
  925.      the specified device, whereas the latter uses X-specific fonts and
  926.      metrics.
  927.  
  928. `-N'
  929.      Don't allow newlines with `eqn' delimiters.  This is the same as
  930.      the `-N' option in `geqn'.
  931.  
  932. `-S'
  933.      Safer mode.  Pass the `-S' option to `gpic' and disable the
  934.      `open', `opena', `pso', `sy', and `pi' requests.  For security
  935.      reasons, this is enabled by default.
  936.  
  937. `-U'
  938.      Unsafe mode.  Reverts to the old unsafe behaviour.
  939.  
  940. `-a'
  941.      Generate an ASCII approximation of the typeset output.  The
  942.      read-only register `.A' is then set to 1.  *Note Built-in
  943.      Registers::.  A typical example is
  944.  
  945.  
  946.           groff -a -man -Tdvi troff.man | less
  947.  
  948.      which shows how lines are broken for the DVI device.  Note that
  949.      this option is rather useless today since graphic output devices
  950.      are available virtually everywhere.
  951.  
  952. `-b'
  953.      Print a backtrace with each warning or error message.  This
  954.      backtrace should help track down the cause of the error.  The line
  955.      numbers given in the backtrace may not always be correct: `gtroff'
  956.      can get confused by `as' or `am' requests while counting line
  957.      numbers.
  958.  
  959. `-i'
  960.      Read the standard input after all the named input files have been
  961.      processed.
  962.  
  963. `-wNAME'
  964.      Enable warning NAME.  Available warnings are described in *Note
  965.      Debugging::.  Multiple `-w' options are allowed.
  966.  
  967. `-WNAME'
  968.      Inhibit warning NAME.  Multiple `-W' options are allowed.
  969.  
  970. `-E'
  971.      Inhibit all error messages.
  972.  
  973. `-C'
  974.      Enable compatibility mode.  *Note Implementation Differences::,
  975.      for the list of incompatibilities between `groff' and traditional
  976.      Unix `troff'.
  977.  
  978. `-dCS'
  979. `-dNAME=s'
  980.      Define C or NAME to be a string S.  C must be a one-letter name;
  981.      NAME can be of arbitrary length.  All string assignments happen
  982.      before loading any macro file (including the start-up file).
  983.  
  984. `-fFAM'
  985.      Use FAM as the default font family.  *Note Font Families::.
  986.  
  987. `-mNAME'
  988.      Read in the file `NAME.tmac'.  Normally `groff' searches for this
  989.      in its macro directories.  If it isn't found, it tries `tmac.NAME'
  990.      (and searches in the same directories).
  991.  
  992. `-nNUM'
  993.      Number the first page NUM.
  994.  
  995. `-oLIST'
  996.      Output only pages in LIST, which is a comma-separated list of page
  997.      ranges; `N' means print page N, `M-N' means print every page
  998.      between M and N, `-N' means print every page up to N, `N-' means
  999.      print every page beginning with N.  `gtroff' exits after printing
  1000.      the last page in the list.  All the ranges are inclusive on both
  1001.      ends.
  1002.  
  1003.      Within `gtroff', this information can be extracted with the `.P'
  1004.      register.  *Note Built-in Registers::.
  1005.  
  1006.      If your document restarts page numbering at the beginning of each
  1007.      chapter, then `gtroff' prints the specified page range for each
  1008.      chapter.
  1009.  
  1010. `-rCN'
  1011. `-rNAME=N'
  1012.      Set number register C or NAME to the value N.  C must be a
  1013.      one-letter name; NAME can be of arbitrary length.  N can be any
  1014.      `gtroff' numeric expression.  All register assignments happen
  1015.      before loading any macro file (including the start-up file).
  1016.  
  1017. `-FDIR'
  1018.      Search `DIR' for subdirectories `devNAME' (NAME is the name of the
  1019.      device), for the `DESC' file, and for font files before looking in
  1020.      the standard directories.
  1021.  
  1022. `-MDIR'
  1023.      Search directory `DIR' for macro files before the standard
  1024.      directories.
  1025.  
  1026. `-IDIR'
  1027.      This option is as described in *Note gsoelim::.  It implies the
  1028.      `-s' option.
  1029.  
  1030. 
  1031. File: groff,  Node: Environment,  Next: Invocation Examples,  Prev: Groff Options,  Up: Invoking groff
  1032.  
  1033. Environment
  1034. ===========
  1035.  
  1036.    There are also several environment variables (of the operating
  1037. system, not within `gtroff') which can modify the behavior of `groff'.
  1038.  
  1039. `GROFF_COMMAND_PREFIX'
  1040.      If this is set to X, then `groff' runs `Xtroff' instead of
  1041.      `gtroff'.  This also applies to `tbl', `pic', `eqn', `grn',
  1042.      `refer', and `soelim'.  It does not apply to `grops', `grodvi',
  1043.      `grotty', `pre-grohtml', `post-grohtml', `grolj4', and `gxditview'.
  1044.  
  1045. `GROFF_TMAC_PATH'
  1046.      A colon-separated list of directories in which to search for macro
  1047.      files (before the default directories are tried).
  1048.  
  1049. `GROFF_TYPESETTER'
  1050.      The default output device.
  1051.  
  1052. `GROFF_FONT_PATH'
  1053.      A colon-separated list of directories in which to search for the
  1054.      `dev'NAME directory (before the default directories are tried).
  1055.  
  1056. `GROFF_BIN_PATH'
  1057.      This search path, followed by `PATH', is used for commands executed
  1058.      by `groff'.
  1059.  
  1060. `GROFF_TMPDIR'
  1061.      The directory in which `groff' creates temporary files.  If this is
  1062.      not set and `TMPDIR' is set, temporary files are created in that
  1063.      directory.  Otherwise temporary files are created in a
  1064.      system-dependent default directory (on Unix and GNU/Linux systems,
  1065.      this is usually `/tmp').  `grops', `grefer', `pre-grohtml', and
  1066.      `post-grohtml' can create temporary files in this directory.
  1067.  
  1068.    Note that MS-DOS and MS-Windows ports of `groff' use semi-colons,
  1069. rather than colons, to separate the directories in the lists described
  1070. above.
  1071.  
  1072. 
  1073. File: groff,  Node: Invocation Examples,  Prev: Environment,  Up: Invoking groff
  1074.  
  1075. Invocation Examples
  1076. ===================
  1077.  
  1078.    This section lists several common uses of `groff' and the
  1079. corresponding command lines.
  1080.  
  1081.  
  1082.      groff file
  1083.  
  1084. This command processes `file' without a macro package or a
  1085. preprocessor.  The output device is the default, `ps', and the output
  1086. is sent to `stdout'.
  1087.  
  1088.  
  1089.      groff -t -mandoc -Tascii file | less
  1090.  
  1091. This is basically what a call to the `man' program does.  `gtroff'
  1092. processes the manual page `file' with the `mandoc' macro file (which in
  1093. turn either calls the `man' or the `mdoc' macro package), using the
  1094. `tbl' preprocessor and the ASCII output device.  Finally, the `less'
  1095. pager displays the result.
  1096.  
  1097.  
  1098.      groff -X -m me file
  1099.  
  1100. Preview `file' with `gxditview', using the `me' macro package.  Since
  1101. no `-T' option is specified, use the default device (`ps').  Note that
  1102. you can either say `-m me' or `-me'; the latter is an anachronism from
  1103. the early days of UNIX.(1) (*note Invocation Examples-Footnote-1::)
  1104.  
  1105.  
  1106.      groff -man -rD1 -z file
  1107.  
  1108. Check `file' with the `man' macro package, forcing double-sided
  1109. printing - don't produce any output.
  1110.  
  1111. * Menu:
  1112.  
  1113. * grog::
  1114.  
  1115. 
  1116. File: groff,  Node: Invocation Examples-Footnotes,  Up: Invocation Examples
  1117.  
  1118.    (1) The same is true for the other main macro packages that come
  1119. with `groff': `man', `mdoc', `ms', `mm', and `mandoc'.  This won't work
  1120. in general; for example, to load `trace.tmac', either `-mtrace' or
  1121. `-m trace' must be used.
  1122.  
  1123. 
  1124. File: groff,  Node: grog,  Prev: Invocation Examples,  Up: Invocation Examples
  1125.  
  1126. `grog'
  1127. ------
  1128.  
  1129.    `grog' reads files, guesses which of the `groff' preprocessors
  1130. and/or macro packages are required for formatting them, and prints the
  1131. `groff' command including those options on the standard output.  It
  1132. generates one or more of the options `-e', `-man', `-me', `-mm', `-ms',
  1133. `-mdoc', `-mdoc-old', `-p', `-R', `-g', `-G', `-s', and `-t'.
  1134.  
  1135.    A special file name `-' refers to the standard input.  Specifying no
  1136. files also means to read the standard input.  Any specified options are
  1137. included in the printed command.  No space is allowed between options
  1138. and their arguments.  The only options recognized are `-C' (which is
  1139. also passed on) to enable compatibility mode, and `-v' (if it is the
  1140. only parameter) to print the version number.
  1141.  
  1142.    For example,
  1143.  
  1144.  
  1145.      grog -Tdvi paper.ms
  1146.  
  1147. guesses the appropriate command to print `paper.ms' and then prints it
  1148. to the command line after adding the `-Tdvi' option.  For direct
  1149. execution, enclose the call to `grog' in backquotes at the UNIX shell
  1150. prompt:
  1151.  
  1152.  
  1153.      `grog -Tdvi paper.ms` > paper.dvi
  1154.  
  1155. As seen in the example, it is still necessary to redirect the output to
  1156. something meaningful (i.e. either a file or a pager program like
  1157. `less').
  1158.  
  1159. 
  1160. File: groff,  Node: Tutorial for Macro Users,  Next: Macro Packages,  Prev: Invoking groff,  Up: Top
  1161.  
  1162. Tutorial for Macro Users
  1163. ************************
  1164.  
  1165.    Most users tend to use a macro package to format their papers.  This
  1166. means that the whole breadth of `groff' is not necessary for most
  1167. people.  This chapter covers the material needed to efficiently use a
  1168. macro package.
  1169.  
  1170. * Menu:
  1171.  
  1172. * Basics::
  1173. * Common Features::
  1174.  
  1175.